DOCUMENTATION · BETA

Getting started

OPNduck is beta software. Things will change, break, and get renamed. These docs describe how it's meant to work today — if something here doesn't match reality, the reality is probably a bug, so file an issue.

Everything runs on your machine. No account, no cloud, no telemetry. If a step here asks you to log in anywhere, it's wrong.

Installation

Grab a pre-built installer from the Download page, or run it from source — same commands on Linux and Windows. Requires Node.js LTS v20+.

git clone https://github.com/Sight8218/OPNduck.git
cd OPNduck
npm install
npm run desktop:dev     # launches the app in dev mode

Prefer it in a plain browser tab instead of the desktop shell? npm run dev starts a web dev server at localhost:1420 with the identical frontend. Exact commands may differ between commits — always check the repo README for the current entry point.

GPU setup

OPNduck detects your hardware on launch and picks a backend. You can override it in settings if detection guesses wrong.

{{ g.name }}

The four tools

These tools all work in the current beta (v0.6.1). See the Roadmap for everything that has shipped.

{{ t.num }}

Building your own installer

Package a Linux (AppImage + pacman) or Windows (NSIS installer + portable exe) build from the same source tree used for the official releases.

npm install
npm run dist:linux     # Linux: AppImage + .pacman
npm run dist:win       # Windows: installer + portable .exe
npm run dist           # both platforms

Output lands in release-build/. Cross-building Windows installers from Linux (or vice versa) may need extra tooling from electron-builder — building on the target OS is the reliable path.

Troubleshooting

Still stuck?

Open an issue with your OS, GPU, and the full error output.

File an issue →